---
id: pinList
title: ''
---

## URL
https://api.decoo-cloud.cn/pinning/pinList

## 描述
获取用户存储的文件列表。

## 请求类型
GET

## Headers
```
"Authorization": "Bearer <YOUR_API_KEY>"
```

## Request

可以通过一些参数对查询结果进行过滤：

- *sort*: 对查询结果按照日期进行排序。
  - *ASC*: 升序排列。
  - *DESC*: 降序排列 (默认行为)。
- *start-date (必须是 ISO_8601 格式)*: 该时间点之前存储的文件不返回。
- *end-date (必须是 ISO_8601 格式)*: 该时间点之后存储的文件不返回。
- *offset*: 分页获取的起始下标，默认为0。
- *limit*: 分页获取的数量，默认为5，最大值为1000。


## Response
```json
{
  "Count": "<文件数量 (根据查询条件)>",
  "Pins": [
    {
      "Id": "<Pin Id>",
      "PinHash": "<文件 CID>",
      "PinSize": "<文件大小 (字节)>",
      "PinDate": "<文件存储时间 (ISO_8601 格式)>",
      "Metadata": {
        "name": "<自定义文件名>"
      }
    },
    {
      ...
    }
  ]
}
```

## Curl 请求示例
```sh
curl -X GET "https://api.decoo-cloud.cn/pinning/pinList?sort=DESC&offset=0&limit=10&start-date=2021-01-01T00:00:00.000+08:00" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"
```
